home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / AIncludes / FileManagerSPI.a < prev    next >
Text File  |  1996-05-01  |  51KB  |  1,317 lines
  1. ;
  2. ;    File:        FileManagerSPI.a
  3. ;
  4. ;    Contains:    FileManager extended interface
  5. ;
  6. ;    Version:    Technology:    System 8
  7. ;                Release:    Universal Interfaces 3.0d3 on Copland DR1
  8. ;
  9. ;    Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10. ;
  11. ;    Bugs?:        If you find a problem with this file, send the file and version
  12. ;                information (from above) and the problem description to:
  13. ;
  14. ;                    Internet:    apple.bugs@applelink.apple.com
  15. ;                    AppleLink:    APPLE.BUGS
  16. ;
  17. ;
  18.     IF &TYPE('__FILEMANAGERSPI__') = 'UNDEFINED' THEN
  19. __FILEMANAGERSPI__ SET 1
  20.  
  21.     IF &TYPE('__KERNEL__') = 'UNDEFINED' THEN
  22.     include 'Kernel.a'
  23.     ENDIF
  24.     IF &TYPE('__FILEMANAGERTYPES__') = 'UNDEFINED' THEN
  25.     include 'FileManagerTypes.a'
  26.     ENDIF
  27.     IF &TYPE('__FILES__') = 'UNDEFINED' THEN
  28.     include 'Files.a'
  29.     ENDIF
  30. ;  You can use FileManager.h or FileManagerSPI.h, but not both 
  31.     IF &TYPE('__FILEMANAGER__') = 'UNDEFINED' THEN
  32.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  33. ; >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> C O N T A I N E R S <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  34. ;
  35. ;****************************************************************************
  36. ;    OBJECTS
  37. ;****************************************************************************
  38. ;
  39. ;
  40. ;    Function:    FSObjectRefClone
  41. ;    Purpose:    Return a copy of an FSObjectRef such that the copy also needs to be disposed.
  42. ;    Inputs:
  43. ;                object_t        The object ref to be cloned.
  44. ;    Outputs:
  45. ;                clone_o            Copy of object_t.
  46. ;    Notes:
  47. ;                The value returned is the same value passed as input in object_t.  This call
  48. ;                would typically be used to balance a future call to FSObjectRefDispose.  Some
  49. ;                examples where it might be used:
  50. ;                    * A called procedure needs to save an FSObjectRef for future use, but the
  51. ;                      calling conventions dictate that the caller is responsible for disposing
  52. ;                      of the ref.  The called function could call FSObjectRefClone to make its
  53. ;                      copy.  The caller can safely dispose of the ref, yet the callee can use
  54. ;                      the ref until doing its own dispose.
  55. ;                    * In object-oriented programming, an object could be passed an FSObjectRef
  56. ;                      in its constructor.  The destructor would be expected to dispose the ref,
  57. ;                      but so would the routine that created the object.  FSObjectRefClone could
  58. ;                      be used in the constructor.
  59. ;                
  60. ;                The returned FSObjectRef is registered to the calling process (as must object_t).
  61. ;
  62. ;
  63. ; extern OSStatus FSObjectRefClone(FSObjectRef object_t, FSObjectRef *clone_o)
  64. ;
  65.     IF GENERATINGCFM THEN
  66.         IMPORT_CFM_FUNCTION FSObjectRefClone
  67.     ENDIF
  68.  
  69. ;
  70. ; extern OSStatus FSObjectRefCloneAsync(FSObjectRef object_t, const KernelNotification *completion_i, FSObjectRef *clone_o, MessageID *requestID_o)
  71. ;
  72.     IF GENERATINGCFM THEN
  73.         IMPORT_CFM_FUNCTION FSObjectRefCloneAsync
  74.     ENDIF
  75.  
  76. ;
  77. ;    Function:    FSObjectRefDispose
  78. ;    Purpose:    Dispose of an FSObjectRef previously returned to a process.
  79. ;    Inputs:
  80. ;                object_t        The object ref to be disposed.
  81. ;    Outputs:
  82. ;    Notes:
  83. ;                A process must dispose of all FSObjectRefs returned to it.  The FSObjectRefs
  84. ;                may be returned as explicit output parameters, or as properties.  If a ref
  85. ;                is returned several times for a given object, it must be disposed for each
  86. ;                time it was returned.
  87. ;                
  88. ;                When all refs to a given object are disposed, the File Manager will dispose
  89. ;                of any resources it allocated in order to operate on that object.  All refs
  90. ;                for a process will be automatically disposed upon process termination.
  91. ;                
  92. ;                For refs returned as properties (especially when iterating over muliple
  93. ;                objects), the FSObjectRefDisposeBulk call may be more convenient.
  94. ;
  95. ;
  96. ; extern OSStatus FSObjectRefDispose(FSObjectRef object_t)
  97. ;
  98.     IF GENERATINGCFM THEN
  99.         IMPORT_CFM_FUNCTION FSObjectRefDispose
  100.     ENDIF
  101.  
  102. ;
  103. ; extern OSStatus FSObjectRefDisposeAsync(FSObjectRef object_t, const KernelNotification *completion_i, MessageID *requestID_o)
  104. ;
  105.     IF GENERATINGCFM THEN
  106.         IMPORT_CFM_FUNCTION FSObjectRefDisposeAsync
  107.     ENDIF
  108.  
  109. ;
  110. ;    Function:    FSObjectRefDisposeBulk
  111. ;    Purpose:    Dispose of many FSObjectRefs, using a list of property descriptors.
  112. ;                (Typically used to dispose all refs returned by FSObjectIterate).
  113. ;    Inputs:
  114. ;                objectCount_i        Number of objects returned by FSObjectIterate.
  115. ;                propertyCount_i        Number of properties per object, as passed to FSObjectIterate.
  116. ;                statusBuffer_i        Status buffer as returned by FSObjectIterate.
  117. ;                properties_i        List of property descriptors passed to FSObjectIterate.
  118. ;                propertiesBuffer_i    Buffer where property values were returned by FSObjectIterate.
  119. ;    Outputs:
  120. ;                statusBuffer_o        Error status for each property of each object.
  121. ;    Notes:
  122. ;                This call is intended to make it easy to dispose of FSObjectRefs returned by an
  123. ;                FSObjectIterate call.  You would pass the same property count, property descriptor
  124. ;                list and property value buffer as was passed to FSObjectIterate.  You also pass the
  125. ;                object count and status buffer as returned by FSObjectIterate (since these tell which
  126. ;                properties were actually returned).
  127. ;                
  128. ;                Any property in properties_i that does not contain an FSObjectRef is ignored.  Any
  129. ;                property that does not have E_NoError in its propertyStatus field (in statusBuffer_i)
  130. ;                is ignored.
  131. ;                
  132. ;                All elements of statusBuffer_o will be set.  If the property was ignored (as described
  133. ;                above), then its propertyStatus is set to E_NoError; otherwise, it is set based on the
  134. ;                attempt to dispose of the ref.  The propertyValueActualSize fields are all set to 0.
  135. ;
  136. ;
  137. ;
  138. ; extern OSStatus FSObjectRefDisposeBulk(ItemCount objectCount_i, ItemCount propertyCount_i, const FSBufferDescriptor *statusBuffer_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, FSBufferDescriptor *statusBuffer_o)
  139. ;
  140.     IF GENERATINGCFM THEN
  141.         IMPORT_CFM_FUNCTION FSObjectRefDisposeBulk
  142.     ENDIF
  143.  
  144. ; 
  145. ;
  146. ; extern OSStatus FSObjectRefDisposeBulkAsync(ItemCount objectCount_i, ItemCount propertyCount_i, const FSBufferDescriptor *statusBuffer_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, MessageID *requestID_o)
  147. ;
  148.     IF GENERATINGCFM THEN
  149.         IMPORT_CFM_FUNCTION FSObjectRefDisposeBulkAsync
  150.     ENDIF
  151.  
  152. ;
  153. ;    Function:    FSObjectRefRegister
  154. ;    Purpose:    Allow an FSObjectRef to be used by another process.
  155. ;    Inputs:
  156. ;                senderObject_t        The object ref.
  157. ;                receiverPid_i        The other process that will be using senderObject_t.
  158. ;    Outputs:
  159. ;    Notes:
  160. ;                This call allows one process to send an FSObjectRef to another process
  161. ;                such that the other process can use the FSObjectRef itself.  The process
  162. ;                specified by receiverPid_i must also dispose of senderObject_t.  The File
  163. ;                Manager acts as if senderObject_t has been returned to receiverPid_i.
  164. ;
  165. ;
  166. ;
  167. ;
  168. ;
  169. ;                You might use this call if you have several processes where one process
  170. ;                (typically a server of some kind) obtains FSObjectRefs for use by other
  171. ;                processes (typically clients of that server).  If the other process (as
  172. ;                specified by receiverPid_i) won't actually call the File Manager with
  173. ;                that FSObjectRef, then it doesn't need to be registered to that process.
  174. ;
  175. ;                It would also be possible to have the server process make all of the
  176. ;                calls to the File Manager.  FSObjectRefs could still be passed between
  177. ;                client and server, but if the clients never use the refs directly, then
  178. ;                there would be no need to register the refs to those clients.  (But beware:
  179. ;                the server would still be responsible for disposing of all refs returned to
  180. ;                it; the server would probably have some cleanup and disposal to do if one
  181. ;                of its client processes were to terminate.)
  182. ;
  183. ;
  184. ; extern OSStatus FSObjectRefRegister(FSObjectRef senderObject_t, KernelProcessID receiverPid_i)
  185. ;
  186.     IF GENERATINGCFM THEN
  187.         IMPORT_CFM_FUNCTION FSObjectRefRegister
  188.     ENDIF
  189.  
  190. ;
  191. ; extern OSStatus FSObjectRefRegisterAsync(FSObjectRef senderObject_t, KernelProcessID receiverPid_i, const KernelNotification *completion_i, MessageID *requestID_o)
  192. ;
  193.     IF GENERATINGCFM THEN
  194.         IMPORT_CFM_FUNCTION FSObjectRefRegisterAsync
  195.     ENDIF
  196.  
  197. ;
  198. ;============================================================================
  199. ;    Volume Sets
  200. ;============================================================================
  201. ;
  202. ;
  203. ;    Function:    FSVolumeSetGetInformation
  204. ;    Purpose:    Returns an FSObjectRef for a Volume Set specified by an
  205. ;                FSVolumeSetObjID.
  206. ;    Inputs:
  207. ;                volumeSet_t                The volume set.
  208. ;    Outputs:
  209. ;                object_o                Object ref for the volume set.
  210. ;                includesBootVolume_o    True if the volume set includes the boot volume.
  211. ;    Notes:
  212. ;                There is currently only one volume set.  In the future there could be others
  213. ;                (perhaps file servers; perhaps to support multiple local users).
  214. ;
  215. ;
  216. ; extern OSStatus FSVolumeSetGetInformation(FSVolumeSetObjID volumeSet_t, Boolean *includesBootVolume_o, FSObjectRef *object_o)
  217. ;
  218.     IF GENERATINGCFM THEN
  219.         IMPORT_CFM_FUNCTION FSVolumeSetGetInformation
  220.     ENDIF
  221.  
  222. ;
  223. ; extern OSStatus FSVolumeSetGetInformationAsync(FSVolumeSetObjID volumeSet_t, const KernelNotification *completion_i, Boolean *includesBootVolume_o, FSObjectRef *object_o, MessageID *requestID_o)
  224. ;
  225.     IF GENERATINGCFM THEN
  226.         IMPORT_CFM_FUNCTION FSVolumeSetGetInformationAsync
  227.     ENDIF
  228.  
  229. ;
  230. ;============================================================================
  231. ;    Volumes
  232. ;============================================================================
  233. ;
  234. ; 
  235. ;
  236. ; extern OSStatus FSVolumeGetInformation(FSVolumeObjID volume_t, FSObjectRef *object_o)
  237. ;
  238.     IF GENERATINGCFM THEN
  239.         IMPORT_CFM_FUNCTION FSVolumeGetInformation
  240.     ENDIF
  241.  
  242. ;
  243. ; extern OSStatus FSVolumeGetInformationAsync(FSVolumeObjID volume_t, const KernelNotification *completion_i, FSObjectRef *objectRef_o, MessageID *requestID_o)
  244. ;
  245.     IF GENERATINGCFM THEN
  246.         IMPORT_CFM_FUNCTION FSVolumeGetInformationAsync
  247.     ENDIF
  248.  
  249. ;  
  250. ;
  251. ; extern OSStatus FSVolumeMount(ObjectID device_t, FSVolumeCapabilities requiredCapabilities_i, const FSMountAccessConstraints *constraints_i, FSObjectRef *volume_o)
  252. ;
  253.     IF GENERATINGCFM THEN
  254.         IMPORT_CFM_FUNCTION FSVolumeMount
  255.     ENDIF
  256.  
  257. ;
  258. ; extern OSStatus FSVolumeMountAsync(ObjectID device_t, FSVolumeCapabilities requiredCapabilities_i, const FSMountAccessConstraints *constraints_i, const KernelNotification *completion_i, FSObjectRef *volume_o, MessageID *requestID_o)
  259. ;
  260.     IF GENERATINGCFM THEN
  261.         IMPORT_CFM_FUNCTION FSVolumeMountAsync
  262.     ENDIF
  263.  
  264. ;  
  265. ;
  266. ; extern OSStatus FSVolumeUnmount(FSObjectRef volume_t)
  267. ;
  268.     IF GENERATINGCFM THEN
  269.         IMPORT_CFM_FUNCTION FSVolumeUnmount
  270.     ENDIF
  271.  
  272. ;
  273. ; extern OSStatus FSVolumeUnmountAsync(FSObjectRef volume_t, const KernelNotification *completion_i, MessageID *requestID_o)
  274. ;
  275.     IF GENERATINGCFM THEN
  276.         IMPORT_CFM_FUNCTION FSVolumeUnmountAsync
  277.     ENDIF
  278.  
  279. ;
  280. ;============================================================================
  281. ;    Folders
  282. ;============================================================================
  283. ;
  284. ;  
  285. ;
  286. ; extern OSStatus FSFolderCreateWithProperties(FSObjectRef container_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, FSBufferDescriptor *statusBuffer_o, FSObjectRef *folder_o)
  287. ;
  288.     IF GENERATINGCFM THEN
  289.         IMPORT_CFM_FUNCTION FSFolderCreateWithProperties
  290.     ENDIF
  291.  
  292. ;
  293. ; extern OSStatus FSFolderCreateWithPropertiesAsync(FSObjectRef container_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, FSObjectRef *folder_o, MessageID *requestID_o)
  294. ;
  295.     IF GENERATINGCFM THEN
  296.         IMPORT_CFM_FUNCTION FSFolderCreateWithPropertiesAsync
  297.     ENDIF
  298.  
  299. ;
  300. ;============================================================================
  301. ;    Files
  302. ;============================================================================
  303. ;
  304. ;  
  305. ;
  306. ; extern OSStatus FSFileCreateWithProperties(FSObjectRef container_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, FSBufferDescriptor *statusBuffer_o, FSObjectRef *file_o)
  307. ;
  308.     IF GENERATINGCFM THEN
  309.         IMPORT_CFM_FUNCTION FSFileCreateWithProperties
  310.     ENDIF
  311.  
  312. ;
  313. ; extern OSStatus FSFileCreateWithPropertiesAsync(FSObjectRef container_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, FSObjectRef *file_o, MessageID *requestID_o)
  314. ;
  315.     IF GENERATINGCFM THEN
  316.         IMPORT_CFM_FUNCTION FSFileCreateWithPropertiesAsync
  317.     ENDIF
  318.  
  319. ;
  320. ;============================================================================
  321. ;    Folder and File Requests
  322. ;============================================================================
  323. ;
  324. ; 
  325. ;
  326. ; extern OSStatus FSObjectCopy(FSObjectRef sourceObject_t, FSObjectRef container_i, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, FSBufferDescriptor *statusBuffer_o, FSObjectRef *newObject_o)
  327. ;
  328.     IF GENERATINGCFM THEN
  329.         IMPORT_CFM_FUNCTION FSObjectCopy
  330.     ENDIF
  331.  
  332. ;
  333. ; extern OSStatus FSObjectCopyAsync(FSObjectRef sourceObject_t, FSObjectRef container_i, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, FSObjectRef *newObject_o, MessageID *requestID_o)
  334. ;
  335.     IF GENERATINGCFM THEN
  336.         IMPORT_CFM_FUNCTION FSObjectCopyAsync
  337.     ENDIF
  338.  
  339. ;
  340. ;    Function:    FSObjectDelete
  341. ;    Purpose:    Deletes an object.  The FSObjectRef is NOT disposed; you must still dispose it yourself.
  342. ;                Further attempts to use the ref will return errors (such as E_ObjectNotFound).
  343. ;
  344. ;    Inputs:
  345. ;                object_t        The object to be deleted.
  346. ;    Outputs:
  347. ;
  348. ;
  349. ; extern OSStatus FSObjectDelete(FSObjectRef object_t)
  350. ;
  351.     IF GENERATINGCFM THEN
  352.         IMPORT_CFM_FUNCTION FSObjectDelete
  353.     ENDIF
  354.  
  355. ;
  356. ; extern OSStatus FSObjectDeleteAsync(FSObjectRef object_t, const KernelNotification *completion_i, MessageID *requestID_o)
  357. ;
  358.     IF GENERATINGCFM THEN
  359.         IMPORT_CFM_FUNCTION FSObjectDeleteAsync
  360.     ENDIF
  361.  
  362. ; 
  363. ;
  364. ; extern OSStatus FSObjectMove(FSObjectRef sourceObject_t, FSObjectRef container_i, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, FSBufferDescriptor *statusBuffer_o)
  365. ;
  366.     IF GENERATINGCFM THEN
  367.         IMPORT_CFM_FUNCTION FSObjectMove
  368.     ENDIF
  369.  
  370. ;
  371. ; extern OSStatus FSObjectMoveAsync(FSObjectRef sourceObject_t, FSObjectRef container_i, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertyValues_i, const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, MessageID *requestID_o)
  372. ;
  373.     IF GENERATINGCFM THEN
  374.         IMPORT_CFM_FUNCTION FSObjectMoveAsync
  375.     ENDIF
  376.  
  377. ;
  378. ;****************************************************************************
  379. ;    PROPERTIES
  380. ;****************************************************************************
  381. ;
  382. ;
  383. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  384. ;    Object Properties
  385. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  386. ;
  387. ; 
  388. ;
  389. ; extern OSStatus FSObjectCreateProperties(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, FSBufferDescriptor *statusBuffer_o)
  390. ;
  391.     IF GENERATINGCFM THEN
  392.         IMPORT_CFM_FUNCTION FSObjectCreateProperties
  393.     ENDIF
  394.  
  395. ;
  396. ; extern OSStatus FSObjectCreatePropertiesAsync(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, MessageID *requestID_o)
  397. ;
  398.     IF GENERATINGCFM THEN
  399.         IMPORT_CFM_FUNCTION FSObjectCreatePropertiesAsync
  400.     ENDIF
  401.  
  402. ; 
  403. ;
  404. ; extern OSStatus FSObjectDeleteProperties(FSObjectRef object_t, ItemCount propertyCount_i, const FSProperty properties_i[2147483647], FSBufferDescriptor *statusBuffer_o)
  405. ;
  406.     IF GENERATINGCFM THEN
  407.         IMPORT_CFM_FUNCTION FSObjectDeleteProperties
  408.     ENDIF
  409.  
  410. ;
  411. ; extern OSStatus FSObjectDeletePropertiesAsync(FSObjectRef object_t, ItemCount propertyCount_i, const FSProperty properties_i[2147483647], const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, MessageID *requestID_o)
  412. ;
  413.     IF GENERATINGCFM THEN
  414.         IMPORT_CFM_FUNCTION FSObjectDeletePropertiesAsync
  415.     ENDIF
  416.  
  417. ; >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> C a p a b i l i t i e s <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  418. ;
  419. ;****************************************************************************
  420. ;    PROPERTY ACCESS METHODS
  421. ;****************************************************************************
  422. ;
  423. ;
  424. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  425. ;    Object Property Simple Values
  426. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  427. ;
  428. ; 
  429. ;
  430. ; extern OSStatus FSObjectGetProperties(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], FSBufferDescriptor *propertiesBuffer_o, FSBufferDescriptor *statusBuffer_o)
  431. ;
  432.     IF GENERATINGCFM THEN
  433.         IMPORT_CFM_FUNCTION FSObjectGetProperties
  434.     ENDIF
  435.  
  436. ;
  437. ; extern OSStatus FSObjectGetPropertiesAsync(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const KernelNotification *completion_i, FSBufferDescriptor *propertiesBuffer_o, FSBufferDescriptor *statusBuffer_o, MessageID *requestID_o)
  438. ;
  439.     IF GENERATINGCFM THEN
  440.         IMPORT_CFM_FUNCTION FSObjectGetPropertiesAsync
  441.     ENDIF
  442.  
  443. ; 
  444. ;
  445. ; extern OSStatus FSObjectSetProperties(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, FSBufferDescriptor *statusBuffer_o)
  446. ;
  447.     IF GENERATINGCFM THEN
  448.         IMPORT_CFM_FUNCTION FSObjectSetProperties
  449.     ENDIF
  450.  
  451. ;
  452. ; extern OSStatus FSObjectSetPropertiesAsync(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const FSBufferDescriptor *propertiesBuffer_i, const KernelNotification *completion_i, FSBufferDescriptor *statusBuffer_o, MessageID *requestID_o)
  453. ;
  454.     IF GENERATINGCFM THEN
  455.         IMPORT_CFM_FUNCTION FSObjectSetPropertiesAsync
  456.     ENDIF
  457.  
  458. ;
  459. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  460. ;    Object Property Fork Values
  461. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  462. ;
  463. ;
  464. ;============================================================================
  465. ;    Stream-based Access Method
  466. ;============================================================================
  467. ;
  468. ;  
  469. ;
  470. ; extern OSStatus FSStreamAllocate(FSStreamObjID stream_t, const FSForkPositionDescriptor *start_i, FSSize length_i, FSForkAllocationPolicy policy_i, FSSize *actualAllocation_o)
  471. ;
  472.     IF GENERATINGCFM THEN
  473.         IMPORT_CFM_FUNCTION FSStreamAllocate
  474.     ENDIF
  475.  
  476. ;
  477. ; extern OSStatus FSStreamAllocateAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *start_i, FSSize length_i, FSForkAllocationPolicy policy_i, const KernelNotification *completion_i, FSSize *actualAllocation_o, MessageID *requestID_o)
  478. ;
  479.     IF GENERATINGCFM THEN
  480.         IMPORT_CFM_FUNCTION FSStreamAllocateAsync
  481.     ENDIF
  482.  
  483. ;
  484. ;    Function:    FSStreamClose
  485. ;    Purpose:    Close a stream previously opened with FSStreamOpen or FSStreamOpenWithConstraints.
  486. ;    Inputs:
  487. ;                stream_t            The stream to close.
  488. ;    Outputs:
  489. ;    Notes:
  490. ;                Any data written to the stream is flushed (written by the File Manager) before the
  491. ;                stream is closed.  The FSStreamObjID, stream_t, may no longer be used.  Any resources
  492. ;                allocated by the File Manager for use by this stream will be disposed.
  493. ;
  494. ;
  495. ; extern OSStatus FSStreamClose(FSStreamObjID stream_t)
  496. ;
  497.     IF GENERATINGCFM THEN
  498.         IMPORT_CFM_FUNCTION FSStreamClose
  499.     ENDIF
  500.  
  501. ;
  502. ; extern OSStatus FSStreamCloseAsync(FSStreamObjID stream_t, const KernelNotification *completion_i, MessageID *requestID_o)
  503. ;
  504.     IF GENERATINGCFM THEN
  505.         IMPORT_CFM_FUNCTION FSStreamCloseAsync
  506.     ENDIF
  507.  
  508. ;
  509. ;    Function:    FSStreamFlush
  510. ;    Purpose:    Any data written to the stream will be written by the File Manager.
  511. ;    Inputs:
  512. ;                stream_t            The stream to flush.
  513. ;    Outputs:
  514. ;    Notes:
  515. ;                Stream data may still reside in the File Manager's caches, but any changes will have
  516. ;                been written out by the File Manager.  Note that the underlying device's driver, or
  517. ;                the device itself, may cache some data, so the File Manager cannot guarantee that
  518. ;                all data has actually been written to the underlying media.
  519. ;                
  520. ;                Other information about the object (such as its modification date) might not be flushed
  521. ;                by this call, though any volume-level data needed to access the stream will be.
  522. ;
  523. ;
  524. ;
  525. ;
  526. ; extern OSStatus FSStreamFlush(FSStreamObjID stream_t)
  527. ;
  528.     IF GENERATINGCFM THEN
  529.         IMPORT_CFM_FUNCTION FSStreamFlush
  530.     ENDIF
  531.  
  532. ;
  533. ; extern OSStatus FSStreamFlushAsync(FSStreamObjID stream_t, const KernelNotification *completion_i, MessageID *requestID_o)
  534. ;
  535.     IF GENERATINGCFM THEN
  536.         IMPORT_CFM_FUNCTION FSStreamFlushAsync
  537.     ENDIF
  538.  
  539. ;  
  540. ;
  541. ; extern OSStatus FSStreamGetEOF(FSStreamObjID stream_t, FSOffset *currentEOF_o)
  542. ;
  543.     IF GENERATINGCFM THEN
  544.         IMPORT_CFM_FUNCTION FSStreamGetEOF
  545.     ENDIF
  546.  
  547. ;
  548. ; extern OSStatus FSStreamGetEOFAsync(FSStreamObjID stream_t, const KernelNotification *completion_i, FSOffset *currentEOF_o, MessageID *requestID_o)
  549. ;
  550.     IF GENERATINGCFM THEN
  551.         IMPORT_CFM_FUNCTION FSStreamGetEOFAsync
  552.     ENDIF
  553.  
  554. ;  
  555. ;
  556. ; extern OSStatus FSStreamGetInformation(FSStreamObjID stream_t, FSObjectRef *object_o, FSProperty *fork_o, FSForkAccessConstraints *constraints_o)
  557. ;
  558.     IF GENERATINGCFM THEN
  559.         IMPORT_CFM_FUNCTION FSStreamGetInformation
  560.     ENDIF
  561.  
  562. ;
  563. ; extern OSStatus FSStreamGetInformationAsync(FSStreamObjID stream_t, const KernelNotification *completion_i, FSObjectRef *object_o, FSProperty *fork_o, FSForkAccessConstraints *constraints_o, MessageID *requestID_o)
  564. ;
  565.     IF GENERATINGCFM THEN
  566.         IMPORT_CFM_FUNCTION FSStreamGetInformationAsync
  567.     ENDIF
  568.  
  569. ;
  570. ;    Function:    FSStreamGetMark
  571. ;    Purpose:    Returns the current mark (position offset) for a stream.
  572. ;    Inputs:
  573. ;                stream_t            The stream.
  574. ;    Outputs:
  575. ;                currentMark_o        Current offset in the stream, stream_t.
  576. ;    Notes:
  577. ;                This call returns the offset from the start of the file that would be
  578. ;                equivalent to using a FSForkPositionDescriptor whose positionOffset is
  579. ;                0, and whose positionMode is kFSFromMark.  A stream's mark is set to
  580. ;                the byte following the last read or write, or via FSStreamSetMark.
  581. ;
  582. ;
  583. ; extern OSStatus FSStreamGetMark(FSStreamObjID stream_t, FSOffset *currentMark_o)
  584. ;
  585.     IF GENERATINGCFM THEN
  586.         IMPORT_CFM_FUNCTION FSStreamGetMark
  587.     ENDIF
  588.  
  589. ;
  590. ; extern OSStatus FSStreamGetMarkAsync(FSStreamObjID stream_t, const KernelNotification *completion_i, FSOffset *currentMark_o, MessageID *requestID_o)
  591. ;
  592.     IF GENERATINGCFM THEN
  593.         IMPORT_CFM_FUNCTION FSStreamGetMarkAsync
  594.     ENDIF
  595.  
  596. ;  
  597. ;
  598. ; extern OSStatus FSStreamLockRange(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSSize length_i, FSRangeLockOptions options_i, FSOffset *rangeStart_o, FSSize *actualLength_o)
  599. ;
  600.     IF GENERATINGCFM THEN
  601.         IMPORT_CFM_FUNCTION FSStreamLockRange
  602.     ENDIF
  603.  
  604. ;
  605. ; extern OSStatus FSStreamLockRangeAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSSize length_i, FSRangeLockOptions options_i, const KernelNotification *completion_i, FSOffset *rangeStart_o, FSSize *actualLength_o, MessageID *requestID_o)
  606. ;
  607.     IF GENERATINGCFM THEN
  608.         IMPORT_CFM_FUNCTION FSStreamLockRangeAsync
  609.     ENDIF
  610.  
  611. ;  
  612. ;
  613. ; extern OSStatus FSStreamOpenWithConstraints(FSObjectRef object_t, const FSProperty *fork_i, const FSForkAccessConstraints *constraints_i, FSStreamObjID *stream_o)
  614. ;
  615.     IF GENERATINGCFM THEN
  616.         IMPORT_CFM_FUNCTION FSStreamOpenWithConstraints
  617.     ENDIF
  618.  
  619. ;
  620. ; extern OSStatus FSStreamOpenWithConstraintsAsync(FSObjectRef object_t, const FSProperty *fork_i, const FSForkAccessConstraints *constraints_i, const KernelNotification *completion_i, FSStreamObjID *stream_o, MessageID *requestID_o)
  621. ;
  622.     IF GENERATINGCFM THEN
  623.         IMPORT_CFM_FUNCTION FSStreamOpenWithConstraintsAsync
  624.     ENDIF
  625.  
  626. ;  
  627. ;
  628. ; extern OSStatus FSStreamRead(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSStreamIOOptions options_i, FSBufferDescriptor *buffer_o, ByteCount *actualLength_o, FSOffset *currentMark_o)
  629. ;
  630.     IF GENERATINGCFM THEN
  631.         IMPORT_CFM_FUNCTION FSStreamRead
  632.     ENDIF
  633.  
  634. ;
  635. ; extern OSStatus FSStreamReadAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSStreamIOOptions options_i, const KernelNotification *completion_i, FSBufferDescriptor *buffer_o, ByteCount *actualLength_o, FSOffset *currentMark_o, MessageID *requestID_o)
  636. ;
  637.     IF GENERATINGCFM THEN
  638.         IMPORT_CFM_FUNCTION FSStreamReadAsync
  639.     ENDIF
  640.  
  641. ;  
  642. ;
  643. ; extern OSStatus FSStreamReleaseAllocation(FSStreamObjID stream_t, const FSForkPositionDescriptor *start_i, FSSize length_i, FSSize *actualLength_o)
  644. ;
  645.     IF GENERATINGCFM THEN
  646.         IMPORT_CFM_FUNCTION FSStreamReleaseAllocation
  647.     ENDIF
  648.  
  649. ;
  650. ; extern OSStatus FSStreamReleaseAllocationAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *start_i, FSSize length_i, const KernelNotification *completion_i, FSSize *actualLength_o, MessageID *requestID_o)
  651. ;
  652.     IF GENERATINGCFM THEN
  653.         IMPORT_CFM_FUNCTION FSStreamReleaseAllocationAsync
  654.     ENDIF
  655.  
  656. ;  
  657. ;
  658. ; extern OSStatus FSStreamSetEOF(FSStreamObjID stream_t, const FSForkPositionDescriptor *EOF_i, FSForkAllocationPolicy policy_i, FSOffset *currentEOF_o)
  659. ;
  660.     IF GENERATINGCFM THEN
  661.         IMPORT_CFM_FUNCTION FSStreamSetEOF
  662.     ENDIF
  663.  
  664. ;
  665. ; extern OSStatus FSStreamSetEOFAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *EOF_i, FSForkAllocationPolicy policy_i, const KernelNotification *completion_i, FSOffset *currentEOF_o, MessageID *requestID_o)
  666. ;
  667.     IF GENERATINGCFM THEN
  668.         IMPORT_CFM_FUNCTION FSStreamSetEOFAsync
  669.     ENDIF
  670.  
  671. ;
  672. ;    Function:    FSStreamSetMark
  673. ;    Purpose:    Sets the current mark (position offset) for a stream.
  674. ;    Inputs:
  675. ;                stream_t            The stream.
  676. ;                newPosition_i        The new position of the stream's mark.
  677. ;                options_i
  678. ;    Outputs:
  679. ;                originalMark_o        The stream's mark, before being changed (relative
  680. ;                                    to the start of the stream).
  681. ;                currentMark_o        The new mark, relative to the start of the stream.
  682. ;    Notes:
  683. ;                A stream's mark is usually used for sequential access to a stream,
  684. ;                or to position relative to the ending position of the last operation
  685. ;                on a stream.  This call lets you explicitly set the mark for future
  686. ;                operations that will operate relative to the current mark.
  687. ;                
  688. ;                If kFSMarkPinToEOF is set in options_i, and the new position specified
  689. ;                by newPosition_i would exceed the current end of the stream (also known
  690. ;                as End Of File or EOF), then the mark will be set to the EOF and E_NoError
  691. ;                is returned.  Otherwise, an error will returned.  The mark may never be
  692. ;                set past the end of the stream.
  693. ;
  694. ;
  695. ;
  696. ;
  697. ; extern OSStatus FSStreamSetMark(FSStreamObjID stream_t, const FSForkPositionDescriptor *newPosition_i, FSStreamSetMarkOptions options_i, FSOffset *originalMark_o, FSOffset *currentMark_o)
  698. ;
  699.     IF GENERATINGCFM THEN
  700.         IMPORT_CFM_FUNCTION FSStreamSetMark
  701.     ENDIF
  702.  
  703. ;
  704. ; extern OSStatus FSStreamSetMarkAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *newPosition_i, FSStreamSetMarkOptions options_i, const KernelNotification *completion_i, FSOffset *originalMark_o, FSOffset *currentMark_o, MessageID *requestID_o)
  705. ;
  706.     IF GENERATINGCFM THEN
  707.         IMPORT_CFM_FUNCTION FSStreamSetMarkAsync
  708.     ENDIF
  709.  
  710. ;  
  711. ;
  712. ; extern OSStatus FSStreamUnlockRange(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSSize length_i, FSRangeLockOptions options_i)
  713. ;
  714.     IF GENERATINGCFM THEN
  715.         IMPORT_CFM_FUNCTION FSStreamUnlockRange
  716.     ENDIF
  717.  
  718. ;
  719. ; extern OSStatus FSStreamUnlockRangeAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSSize length_i, FSRangeLockOptions options_i, const KernelNotification *completion_i, MessageID *requestID_o)
  720. ;
  721.     IF GENERATINGCFM THEN
  722.         IMPORT_CFM_FUNCTION FSStreamUnlockRangeAsync
  723.     ENDIF
  724.  
  725. ;  
  726. ;
  727. ; extern OSStatus FSStreamWrite(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSStreamIOOptions options_i, const FSBufferDescriptor *buffer_i, ByteCount *actualLength_o, FSOffset *currentMark_o)
  728. ;
  729.     IF GENERATINGCFM THEN
  730.         IMPORT_CFM_FUNCTION FSStreamWrite
  731.     ENDIF
  732.  
  733. ;
  734. ; extern OSStatus FSStreamWriteAsync(FSStreamObjID stream_t, const FSForkPositionDescriptor *position_i, FSStreamIOOptions options_i, const FSBufferDescriptor *buffer_i, const KernelNotification *completion_i, ByteCount *actualLength_o, FSOffset *currentMark_o, MessageID *requestID_o)
  735. ;
  736.     IF GENERATINGCFM THEN
  737.         IMPORT_CFM_FUNCTION FSStreamWriteAsync
  738.     ENDIF
  739.  
  740. ;
  741. ;============================================================================
  742. ;    Memory-mapped Access Method(Backing Store Requests)
  743. ;============================================================================
  744. ;
  745. ;
  746. ;    Function:    FSMappedFileClose
  747. ;    Purpose:    Closes an access path to a file used for backing store.
  748. ;    Inputs:
  749. ;                backingStore_t        The backing store object.
  750. ;    Outputs:
  751. ;    Notes:
  752. ;                Basically the same as FSStreamClose, but for a backing store.
  753. ;                
  754. ;                All data written to this backing store (by writing to pages backed by
  755. ;                this store) will be flushed (written) by the File Manager.
  756. ;
  757. ;
  758. ; extern OSStatus FSMappedFileClose(FSBackingStoreObjID backingStore_t)
  759. ;
  760.     IF GENERATINGCFM THEN
  761.         IMPORT_CFM_FUNCTION FSMappedFileClose
  762.     ENDIF
  763.  
  764. ;
  765. ; extern OSStatus FSMappedFileCloseAsync(FSBackingStoreObjID backingStore_t, const KernelNotification *completion_i, MessageID *requestID_o)
  766. ;
  767.     IF GENERATINGCFM THEN
  768.         IMPORT_CFM_FUNCTION FSMappedFileCloseAsync
  769.     ENDIF
  770.  
  771. ;
  772. ;    Function:    FSMappedFileGetEOF
  773. ;    Purpose:    Return the EOF (length) of the fork being accessed by the given backing store.
  774. ;    Inputs:
  775. ;                backingStore_t        The backing store used to access the fork.
  776. ;    Outputs:
  777. ;                currentEOF_o        The size, in bytes, of the fork.
  778. ;    Notes:
  779. ;                Since access to a fork via a backing store (i.e. memory mapped file access) is
  780. ;                accomplished by directly accessing memory pages, the virtual memory system must
  781. ;                read and write entire pages.  If the last page is modified, the entire page is
  782. ;                written, resulting in the fork size being rounded up to a multiple of a page size.
  783. ;                Similarly for access to pages beyond the fork's EOF.
  784. ;                
  785. ;                This call returns the current EOF (length) of the underlying fork.  This may be
  786. ;                set implicitly by writing to backed pages, or by using the FSBackingStoreSetEOF
  787. ;                call.  It may also be changed by streams opened to the same fork.
  788. ;
  789. ;
  790. ; extern OSStatus FSMappedFileGetEOF(FSBackingStoreObjID backingStore_t, FSOffset *currentEOF_o)
  791. ;
  792.     IF GENERATINGCFM THEN
  793.         IMPORT_CFM_FUNCTION FSMappedFileGetEOF
  794.     ENDIF
  795.  
  796. ;
  797. ; extern OSStatus FSMappedFileGetEOFAsync(FSBackingStoreObjID backingStore_t, const KernelNotification *completion_i, FSOffset *currentEOF_o, MessageID *requestID_o)
  798. ;
  799.     IF GENERATINGCFM THEN
  800.         IMPORT_CFM_FUNCTION FSMappedFileGetEOFAsync
  801.     ENDIF
  802.  
  803. ;  
  804. ;
  805. ; extern OSStatus FSMappedFileGetInformation(FSBackingStoreObjID backingStore_t, FSObjectRef *object_o, FSProperty *fork_o, FSForkAccessConstraints *constraints_o)
  806. ;
  807.     IF GENERATINGCFM THEN
  808.         IMPORT_CFM_FUNCTION FSMappedFileGetInformation
  809.     ENDIF
  810.  
  811. ;
  812. ; extern OSStatus FSMappedFileGetInformationAsync(FSBackingStoreObjID backingStore_t, const KernelNotification *completion_i, FSObjectRef *object_o, FSProperty *fork_o, FSForkAccessConstraints *constraints_o, MessageID *requestID_o)
  813. ;
  814.     IF GENERATINGCFM THEN
  815.         IMPORT_CFM_FUNCTION FSMappedFileGetInformationAsync
  816.     ENDIF
  817.  
  818. ;
  819. ;    Function:    FSMappedFileSetEOF
  820. ;    Purpose:    Sets the EOF (length) of the fork being accessed by the given backing store.
  821. ;    Inputs:
  822. ;                backingStore_t        The backing store used to access the fork.
  823. ;                EOF_i                The new length (EOF) of the fork.
  824. ;                policy_i            Controls how space should be allocated (if the new EOF
  825. ;                                    is larger than the current EOF).
  826. ;    Outputs:
  827. ;                currentEOF_o        The new size, in bytes, of the fork.
  828. ;    Notes:
  829. ;                Since access to a fork via a backing store (i.e. memory mapped file access) is
  830. ;                accomplished by directly accessing memory pages, the virtual memory system must
  831. ;                read and write entire pages.  If the last page is modified, the entire page is
  832. ;                written, resulting in the fork size being rounded up to a multiple of a page size.
  833. ;                Similarly for access to pages beyond the fork's EOF.
  834. ;                
  835. ;                This call allows the EOF to be explicitly set for a fork being accessed via a
  836. ;                backing store.  Any data beyond the EOF will not actually be written to the fork.
  837. ;                The File Manager has no way to detect whether access to pages occurs beyond the
  838. ;                EOF; it is a programming error to access bytes beyond the EOF via a backing store.
  839. ;                
  840. ;                This call would typically be used when a fork has been memory mapped to enable
  841. ;                convenient access to a file's data structures as if it were completely in memory.
  842. ;                You would make all changes to the data structures, then use this call to indicate
  843. ;                the number of bytes that are valid and should be written to the fork.
  844. ;
  845. ;
  846. ; extern OSStatus FSMappedFileSetEOF(FSBackingStoreObjID backingStore_t, const FSForkPositionDescriptor *EOF_i, FSForkAllocationPolicy policy_i, FSOffset *currentEOF_o)
  847. ;
  848.     IF GENERATINGCFM THEN
  849.         IMPORT_CFM_FUNCTION FSMappedFileSetEOF
  850.     ENDIF
  851.  
  852. ;
  853. ; extern OSStatus FSMappedFileSetEOFAsync(FSBackingStoreObjID backingStore_t, const FSForkPositionDescriptor *EOF_i, FSForkAllocationPolicy policy_i, const KernelNotification *completion_i, FSOffset *currentEOF_o, MessageID *requestID_o)
  854. ;
  855.     IF GENERATINGCFM THEN
  856.         IMPORT_CFM_FUNCTION FSMappedFileSetEOFAsync
  857.     ENDIF
  858.  
  859. ;  
  860. ;
  861. ; extern OSStatus FSMappedFileOpenWithConstraints(FSObjectRef object_t, const FSProperty *fork_i, const FSForkAccessConstraints *constraints_i, FSBackingStoreObjID *backingStore_o)
  862. ;
  863.     IF GENERATINGCFM THEN
  864.         IMPORT_CFM_FUNCTION FSMappedFileOpenWithConstraints
  865.     ENDIF
  866.  
  867. ;
  868. ; extern OSStatus FSMappedFileOpenWithConstraintsAsync(FSObjectRef object_t, const FSProperty *fork_i, const FSForkAccessConstraints *constraints_i, const KernelNotification *completion_i, FSBackingStoreObjID *backingStore_o, MessageID *requestID_o)
  869. ;
  870.     IF GENERATINGCFM THEN
  871.         IMPORT_CFM_FUNCTION FSMappedFileOpenWithConstraintsAsync
  872.     ENDIF
  873.  
  874. ;
  875. ;****************************************************************************
  876. ;    NAVIGATION & ENUMERATION
  877. ;****************************************************************************
  878. ;
  879. ;
  880. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  881. ;    Object Iteration
  882. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  883. ;
  884. ; 
  885. ;
  886. ; extern OSStatus FSObjectIterate(FSObjectIteratorObjID iterator_t, ItemCount objectCount_i, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], ItemCount *actualObjectCount_o, FSBufferDescriptor *propertiesBuffer_o, FSBufferDescriptor *statusBuffer_o)
  887. ;
  888.     IF GENERATINGCFM THEN
  889.         IMPORT_CFM_FUNCTION FSObjectIterate
  890.     ENDIF
  891.  
  892. ;
  893. ; extern OSStatus FSObjectIterateAsync(FSObjectIteratorObjID iterator_t, ItemCount objectCount_i, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], const KernelNotification *completion_i, ItemCount *actualObjectCount_o, FSBufferDescriptor *propertiesBuffer_o, FSBufferDescriptor *statusBuffer_o, MessageID *requestID_o)
  894. ;
  895.     IF GENERATINGCFM THEN
  896.         IMPORT_CFM_FUNCTION FSObjectIterateAsync
  897.     ENDIF
  898.  
  899. ;
  900. ;    Function:    FSObjectIteratorChangeCurrentScope
  901. ;    Purpose:    Move an object iterator into or out of a container.
  902. ;    Inputs:
  903. ;                iterator_t        The object iterator.
  904. ;                movement_i        The direction to move: into or out of a container.
  905. ;    Outputs:
  906. ;    Notes:
  907. ;                If movement_i is kFSObjectEnter, then the iterator must be positioned on
  908. ;                an object that is capable of containing other objects; it does not need to
  909. ;                actually contain any objects at that time.  That object will become the new
  910. ;                current scope of the iterator and it will be in Start Of Iteration state
  911. ;                (meaning that all objects in the current scope have yet to be returned).
  912. ;                The iterator will not be positioned on any object.
  913. ;                
  914. ;                If movement_i is kFSObjectExit,  then the current scope will become the object
  915. ;                that contains the current scope; the iterator's new position will be the object
  916. ;                that was the current scope.  If the current scope and the outermost scope were
  917. ;                the same, then the outermost scope will also change to the new current scope and
  918. ;                E_ExitIteratorScope is returned (so that you realize you will be iterating outside
  919. ;                of the scope that you used to create the iterator; the iterator remains usable).
  920. ;                
  921. ;                Object iterators keep track of all of the objects between the outermost scope and
  922. ;                the current scope (this is known as the "scope stack").  If any object in the scope
  923. ;                stack is moved, the iterator is invalidated and will return the error
  924. ;                E_IteratorScopeException until it has been explicitly fixed (by FSObjectIteratorRecreate)
  925. ;                or disposed.  This call adds or removes objects from the scope stack.
  926. ;
  927. ;
  928. ; extern OSStatus FSObjectIteratorChangeCurrentScope(FSObjectIteratorObjID iterator_t, FSObjectIteratorMovement movement_i)
  929. ;
  930.     IF GENERATINGCFM THEN
  931.         IMPORT_CFM_FUNCTION FSObjectIteratorChangeCurrentScope
  932.     ENDIF
  933.  
  934. ;
  935. ; extern OSStatus FSObjectIteratorChangeCurrentScopeAsync(FSObjectIteratorObjID iterator_t, FSObjectIteratorMovement movement_i, const KernelNotification *completion_i, MessageID *requestID_o)
  936. ;
  937.     IF GENERATINGCFM THEN
  938.         IMPORT_CFM_FUNCTION FSObjectIteratorChangeCurrentScopeAsync
  939.     ENDIF
  940.  
  941. ; 
  942. ;
  943. ; extern OSStatus FSObjectIteratorClone(FSObjectIteratorObjID iterator_t, FSObjectIteratorObjID *clone_o)
  944. ;
  945.     IF GENERATINGCFM THEN
  946.         IMPORT_CFM_FUNCTION FSObjectIteratorClone
  947.     ENDIF
  948.  
  949. ;
  950. ; extern OSStatus FSObjectIteratorCloneAsync(FSObjectIteratorObjID iterator_t, const KernelNotification *completion_i, FSObjectIteratorObjID *clone_o, MessageID *requestID_o)
  951. ;
  952.     IF GENERATINGCFM THEN
  953.         IMPORT_CFM_FUNCTION FSObjectIteratorCloneAsync
  954.     ENDIF
  955.  
  956. ;
  957. ;    Function:    FSObjectIteratorCreate
  958. ;    Purpose:    Create an iterator for iterating over objects.
  959. ;    Inputs:
  960. ;                outermostScope_t        The initial outermost scope and current scope.
  961. ;                options_i                Controls whether the iterator will traverse objects in
  962. ;                                        a single container or all embedded (nested) containers.
  963. ;                                        Also controls which kinds of objects will be returned.
  964. ;    Outputs:
  965. ;                iterator_o                The object iterator.
  966. ;    Notes:
  967. ;                The outermost scope and current scope of the iterator are set to outermostScope_t.
  968. ;                The iterator is not positioned on any object, though it is inside outermostScope_t.
  969. ;                OutermostScope_t must be an object capable of containing other objects (such as the
  970. ;                Universe, a volume set, a volume, or a folder).  The iterator is put into "Start Of
  971. ;                Iteration" state, meaning that all objects in the current scope have yet to be
  972. ;                returned.
  973. ;                
  974. ;                The File Manager allocates resources and maintains state for every iterator.  When
  975. ;                you have finished using an iterator, you should call FSObjectIteratorDispose to dispose
  976. ;                of it.
  977. ;
  978. ;
  979. ; extern OSStatus FSObjectIteratorCreate(FSObjectRef outermostScope_t, FSObjectIteratorCreationOptions options_i, FSObjectIteratorObjID *iterator_o)
  980. ;
  981.     IF GENERATINGCFM THEN
  982.         IMPORT_CFM_FUNCTION FSObjectIteratorCreate
  983.     ENDIF
  984.  
  985. ;
  986. ; extern OSStatus FSObjectIteratorCreateAsync(FSObjectRef outermostScope_t, FSObjectIteratorCreationOptions options_i, const KernelNotification *completion_i, FSObjectIteratorObjID *iterator_o, MessageID *requestID_o)
  987. ;
  988.     IF GENERATINGCFM THEN
  989.         IMPORT_CFM_FUNCTION FSObjectIteratorCreateAsync
  990.     ENDIF
  991.  
  992. ;
  993. ;    Function:    FSObjectIteratorDispose
  994. ;    Purpose:    Dispose of an object iterator.
  995. ;    Inputs:
  996. ;                iterator_t        The object iterator.
  997. ;    Outputs:
  998. ;    Notes:
  999. ;                The File Manager will dispose of the iterator and release any resources
  1000. ;                allocated to the iterator.  Further attempts to use the iterator will result
  1001. ;                in an error.
  1002. ;
  1003. ;
  1004. ;
  1005. ;
  1006. ; extern OSStatus FSObjectIteratorDispose(FSObjectIteratorObjID iterator_t)
  1007. ;
  1008.     IF GENERATINGCFM THEN
  1009.         IMPORT_CFM_FUNCTION FSObjectIteratorDispose
  1010.     ENDIF
  1011.  
  1012. ;
  1013. ; extern OSStatus FSObjectIteratorDisposeAsync(FSObjectIteratorObjID iterator_t, const KernelNotification *completion_i, MessageID *requestID_o)
  1014. ;
  1015.     IF GENERATINGCFM THEN
  1016.         IMPORT_CFM_FUNCTION FSObjectIteratorDisposeAsync
  1017.     ENDIF
  1018.  
  1019. ; 
  1020. ;
  1021. ; extern OSStatus FSObjectIteratorGetInformation(FSObjectIteratorObjID iterator_t, FSObjectRef *outermostScope_o, FSObjectRef *currentScope_o, FSObjectIteratorCreationOptions *options_o, FSObjectIteratorState *state_o)
  1022. ;
  1023.     IF GENERATINGCFM THEN
  1024.         IMPORT_CFM_FUNCTION FSObjectIteratorGetInformation
  1025.     ENDIF
  1026.  
  1027. ;
  1028. ; extern OSStatus FSObjectIteratorGetInformationAsync(FSObjectIteratorObjID iterator_t, const KernelNotification *completion_i, FSObjectRef *outermostScope_o, FSObjectRef *currentScope_o, FSObjectIteratorCreationOptions *options_o, FSObjectIteratorState *state_o, MessageID *requestID_o)
  1029. ;
  1030.     IF GENERATINGCFM THEN
  1031.         IMPORT_CFM_FUNCTION FSObjectIteratorGetInformationAsync
  1032.     ENDIF
  1033.  
  1034. ; 
  1035. ;
  1036. ; extern OSStatus FSObjectIteratorRecreate(FSObjectIteratorObjID iterator_t, FSObjectRef outermostScope_i, Boolean preserveCurrentOptions_i, FSObjectIteratorCreationOptions options_i)
  1037. ;
  1038.     IF GENERATINGCFM THEN
  1039.         IMPORT_CFM_FUNCTION FSObjectIteratorRecreate
  1040.     ENDIF
  1041.  
  1042. ;
  1043. ; extern OSStatus FSObjectIteratorRecreateAsync(FSObjectIteratorObjID iterator_t, FSObjectRef outermostScope_i, Boolean preserveCurrentOptions_i, FSObjectIteratorCreationOptions options_i, const KernelNotification *completion_i, MessageID *requestID_o)
  1044. ;
  1045.     IF GENERATINGCFM THEN
  1046.         IMPORT_CFM_FUNCTION FSObjectIteratorRecreateAsync
  1047.     ENDIF
  1048.  
  1049. ;
  1050. ;    Function:    FSObjectIteratorRestart
  1051. ;    Purpose:    Place an object iterator in the Start Of Iterator state, in its current scope.
  1052. ;    Inputs:
  1053. ;                iterator_t        The object iterator.
  1054. ;    Outputs:
  1055. ;    Notes:
  1056. ;                The iterator is not positioned on any object.  The iterator is put into "Start Of
  1057. ;                Iteration" state, meaning that all objects in the current scope have yet to be
  1058. ;                returned.
  1059. ;                
  1060. ;                You would use this call to completely restart iteration within the current scope,
  1061. ;                ignoring any state about objects previously returned in the current scope.  The
  1062. ;                outermost scope is not affected.  State information about which objects have been
  1063. ;                returned from scopes outside the current scope is unchanged.
  1064. ;
  1065. ;
  1066. ; extern OSStatus FSObjectIteratorRestart(FSObjectIteratorObjID iterator_t)
  1067. ;
  1068.     IF GENERATINGCFM THEN
  1069.         IMPORT_CFM_FUNCTION FSObjectIteratorRestart
  1070.     ENDIF
  1071.  
  1072. ;
  1073. ; extern OSStatus FSObjectIteratorRestartAsync(FSObjectIteratorObjID iterator_t, const KernelNotification *completion_i, MessageID *requestID_o)
  1074. ;
  1075.     IF GENERATINGCFM THEN
  1076.         IMPORT_CFM_FUNCTION FSObjectIteratorRestartAsync
  1077.     ENDIF
  1078.  
  1079. ;
  1080. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  1081. ;    Object Resolution
  1082. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  1083. ;
  1084. ;
  1085. ;    Function:    FSObjectExchange
  1086. ;    Purpose:    Exchange the properties of two objects.  Typically used for "safe
  1087. ;                saving", while maintaining an object's persistent reference.
  1088. ;    Inputs:
  1089. ;                object1_i        One object.
  1090. ;                object2_i        The object to exchange it with.
  1091. ;    Outputs:
  1092. ;    Notes:
  1093. ;                This call is used to allow a "safe save" that preserves an object's
  1094. ;                persistent reference.  For example, you might want to save an updated
  1095. ;                set of properties to an object so that any errors while saving result
  1096. ;                in the object being unchanged; but, you also want the object's persistent
  1097. ;                reference to remain unchanged (so that things like aliases still work).
  1098. ;                
  1099. ;                What you would do is create a second object somewhere (in a temporary
  1100. ;                folder, for example).  Write out all of the properties, both unchanged
  1101. ;                and changed, to the second object.  When done saving, you would call
  1102. ;                FSObjectExchange with both objects; the contents of the two objects get
  1103. ;                swapped in such a way that the original object has the new properties,
  1104. ;                but retains its old persistent reference.
  1105. ;
  1106. ;
  1107. ;
  1108. ;
  1109. ; extern OSStatus FSObjectExchange(FSObjectRef object1_i, FSObjectRef object2_i)
  1110. ;
  1111.     IF GENERATINGCFM THEN
  1112.         IMPORT_CFM_FUNCTION FSObjectExchange
  1113.     ENDIF
  1114.  
  1115. ;
  1116. ; extern OSStatus FSObjectExchangeAsync(FSObjectRef object1_i, FSObjectRef object2_i, const KernelNotification *completion_i, MessageID *requestID_o)
  1117. ;
  1118.     IF GENERATINGCFM THEN
  1119.         IMPORT_CFM_FUNCTION FSObjectExchangeAsync
  1120.     ENDIF
  1121.  
  1122. ;
  1123. ;    Function:    FSObjectRefGetFSSpec
  1124. ;    Purpose:    Return an FSSpec for an object (suitable for use with the Files API).
  1125. ;    Inputs:
  1126. ;                object_t            The object.
  1127. ;    Outputs:
  1128. ;                fSSpec_o            An FSSpec that specifies the same object as object_t,
  1129. ;                                    suitable for use with the Files API.
  1130. ;    Notes:
  1131. ;                This call is intended to be used by code that is required to use both the
  1132. ;                Files API and the FileManager API (or has clients that use both APIs).
  1133. ;                For example, a piece of code may already exist with an API that uses FSSpecs,
  1134. ;                but has been converted internally to use the FSObjectRefs; it would use this
  1135. ;                call to produce an FSSpec as an output for the pre-existing API.
  1136. ;                
  1137. ;                It would be best to provide an API that allows its clients to use FSObjectRefs.
  1138. ;
  1139. ;
  1140. ; extern OSStatus FSObjectRefGetFSSpec(FSObjectRef object_t, FSSpec *fSSpec_o)
  1141. ;
  1142.     IF GENERATINGCFM THEN
  1143.         IMPORT_CFM_FUNCTION FSObjectRefGetFSSpec
  1144.     ENDIF
  1145.  
  1146. ;
  1147. ; extern OSStatus FSObjectRefGetFSSpecAsync(FSObjectRef object_t, const KernelNotification *completion_i, FSSpec *fSSpec_o, MessageID *requestID_o)
  1148. ;
  1149.     IF GENERATINGCFM THEN
  1150.         IMPORT_CFM_FUNCTION FSObjectRefGetFSSpecAsync
  1151.     ENDIF
  1152.  
  1153. ; 
  1154. ;
  1155. ; extern OSStatus FSObjectLocate(FSObjectRef container_t, ItemCount elementCount_i, const FSObjectPathwayElement pathway_i[2147483647], const FSBufferDescriptor *pathwayPropertiesBuffer_i, FSObjectRef *object_o)
  1156. ;
  1157.     IF GENERATINGCFM THEN
  1158.         IMPORT_CFM_FUNCTION FSObjectLocate
  1159.     ENDIF
  1160.  
  1161. ;
  1162. ; extern OSStatus FSObjectLocateAsync(FSObjectRef container_t, ItemCount elementCount_i, const FSObjectPathwayElement pathway_i[2147483647], const FSBufferDescriptor *pathwayPropertiesBuffer_i, const KernelNotification *completion_i, FSObjectRef *object_o, MessageID *requestID_o)
  1163. ;
  1164.     IF GENERATINGCFM THEN
  1165.         IMPORT_CFM_FUNCTION FSObjectLocateAsync
  1166.     ENDIF
  1167.  
  1168. ; 
  1169. ;
  1170. ; extern OSStatus FSObjectPersistentReferenceResolve(FSVolumeObjID volume_t, const FSObjectPersistentReference *persistentReference_i, FSObjectRef *object_o)
  1171. ;
  1172.     IF GENERATINGCFM THEN
  1173.         IMPORT_CFM_FUNCTION FSObjectPersistentReferenceResolve
  1174.     ENDIF
  1175.  
  1176. ;
  1177. ; extern OSStatus FSObjectPersistentReferenceResolveAsync(FSVolumeObjID volume_t, const FSObjectPersistentReference *persistentReference_i, const KernelNotification *completion_i, FSObjectRef *object_o, MessageID *requestID_o)
  1178. ;
  1179.     IF GENERATINGCFM THEN
  1180.         IMPORT_CFM_FUNCTION FSObjectPersistentReferenceResolveAsync
  1181.     ENDIF
  1182.  
  1183. ;  
  1184. ;
  1185. ; extern OSStatus FSObjectRefResolve(FSObjectRef object_t, FSVolumeObjID *objectsVolume_o, FSVolumeSetObjID *objectsVolumeSet_o)
  1186. ;
  1187.     IF GENERATINGCFM THEN
  1188.         IMPORT_CFM_FUNCTION FSObjectRefResolve
  1189.     ENDIF
  1190.  
  1191. ;
  1192. ; extern OSStatus FSObjectRefResolveAsync(FSObjectRef object_t, const KernelNotification *completion_i, FSVolumeObjID *objectsVolume_o, FSVolumeSetObjID *objectsVolumeSet_o, MessageID *requestID_o)
  1193. ;
  1194.     IF GENERATINGCFM THEN
  1195.         IMPORT_CFM_FUNCTION FSObjectRefResolveAsync
  1196.     ENDIF
  1197.  
  1198. ;
  1199. ;    Function:    FSSpecGetFSObjectRef
  1200. ;    Purpose:    Return an FSObjectRef for an object specified via an FSSpec.
  1201. ;    Inputs:
  1202. ;                theFSSpec_t            An FSSpec for the object.
  1203. ;    Outputs:
  1204. ;                theObject_o            An FSObjectRef for the object.
  1205. ;    Notes:
  1206. ;                This call is intended to be used by code that is required to use both the
  1207. ;                Files API and the FileManager API (or has clients that use both APIs).
  1208. ;                For example, a piece of code may already exist with an API that uses FSSpecs,
  1209. ;                but has been converted internally to use the FSObjectRefs; it would use this
  1210. ;                call to take an input FSSpec and convert it to an FSObjectRef to use internally;
  1211. ;                the FSObjectRef would then be disposed before completing the call.
  1212. ;                
  1213. ;                It would be best to provide an API that allows its clients to use FSObjectRefs.
  1214. ;
  1215. ;
  1216. ; extern OSStatus FSSpecGetFSObjectRef(const FSSpec *theFSSpec_t, FSObjectRef *theObject_o)
  1217. ;
  1218.     IF GENERATINGCFM THEN
  1219.         IMPORT_CFM_FUNCTION FSSpecGetFSObjectRef
  1220.     ENDIF
  1221.  
  1222. ;  
  1223. ;
  1224. ; extern OSStatus FSUniverseResolve(FSObjectRef *theUniverse_o)
  1225. ;
  1226.     IF GENERATINGCFM THEN
  1227.         IMPORT_CFM_FUNCTION FSUniverseResolve
  1228.     ENDIF
  1229.  
  1230. ;
  1231. ; extern OSStatus FSUniverseResolveAsync(FSObjectRef *theUniverse_o, const KernelNotification *theCompletion_i, MessageID *theRequestID_o)
  1232. ;
  1233.     IF GENERATINGCFM THEN
  1234.         IMPORT_CFM_FUNCTION FSUniverseResolveAsync
  1235.     ENDIF
  1236.  
  1237. ; >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> F a c i l i t i e s <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  1238. ;
  1239. ;============================================================================
  1240. ;    Cache Flush Routines
  1241. ;============================================================================
  1242. ;
  1243. ;
  1244. ;    Function:    FSObjectFlush
  1245. ;    Purpose:    Flushes any data cached by the File Manager for the given object.
  1246. ;    Inputs:
  1247. ;                object_t        The object to be flushed.
  1248. ;    Outputs:
  1249. ;    Notes:
  1250. ;                If object_t is a file, then any data written to that file (via a stream or backing store,
  1251. ;                regardless of the process that opened the stream or backing store) will be written by the
  1252. ;                File Manager to any underlying device.  If object_t is a volume, then any data written to
  1253. ;                any file on that volume will be flushed.
  1254. ;                
  1255. ;                Any change to properties of object_t will be flushed (regardless of the object's type).
  1256. ;                
  1257. ;                Data about the object (or contained in the object) may still reside in the File Manager's
  1258. ;                caches, but any changes will have been written out by the File Manager.  Note that the
  1259. ;                underlying device's driver, or the device itself, may cache some data, so the File Manager
  1260. ;                cannot guarantee that all data has actually been written to the underlying media.
  1261. ;
  1262. ;
  1263. ;
  1264. ;
  1265. ;
  1266. ; extern OSStatus FSObjectFlush(FSObjectRef object_t)
  1267. ;
  1268.     IF GENERATINGCFM THEN
  1269.         IMPORT_CFM_FUNCTION FSObjectFlush
  1270.     ENDIF
  1271.  
  1272. ;
  1273. ; extern OSStatus FSObjectFlushAsync(FSObjectRef object_t, const KernelNotification *completion_i, MessageID *requestID_o)
  1274. ;
  1275.     IF GENERATINGCFM THEN
  1276.         IMPORT_CFM_FUNCTION FSObjectFlushAsync
  1277.     ENDIF
  1278.  
  1279. ;
  1280. ;============================================================================
  1281. ;    Request Cancellation Routines
  1282. ;============================================================================
  1283. ;
  1284. ;  
  1285. ;
  1286. ; extern OSStatus FSRequestCancel(MessageID theRequestID_i)
  1287. ;
  1288.     IF GENERATINGCFM THEN
  1289.         IMPORT_CFM_FUNCTION FSRequestCancel
  1290.     ENDIF
  1291.  
  1292. ;
  1293. ;============================================================================
  1294. ;    Object Property Sizes
  1295. ;============================================================================
  1296. ;
  1297. ; 
  1298. ;
  1299. ; extern OSStatus FSObjectGetForkPropertyPhysicalSizes(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], FSBufferDescriptor *propertiesBuffer_o, FSBufferDescriptor *statusBuffer_o)
  1300. ;
  1301.     IF GENERATINGCFM THEN
  1302.         IMPORT_CFM_FUNCTION FSObjectGetForkPropertyPhysicalSizes
  1303.     ENDIF
  1304.  
  1305. ; 
  1306. ;
  1307. ; extern OSStatus FSObjectGetPropertySizes(FSObjectRef object_t, ItemCount propertyCount_i, const FSPropertyDescriptor properties_i[2147483647], FSBufferDescriptor *propertiesBuffer_o, FSBufferDescriptor *statusBuffer_o)
  1308. ;
  1309.     IF GENERATINGCFM THEN
  1310.         IMPORT_CFM_FUNCTION FSObjectGetPropertySizes
  1311.     ENDIF
  1312.  
  1313.     ENDIF
  1314.     ENDIF
  1315.     ENDIF ; __FILEMANAGERSPI__ 
  1316.  
  1317.